Interface PingProcess

All Superinterfaces:
IPCObject, Process
All Known Implementing Classes:
PingProcessImpl

public interface PingProcess extends Process
Information provided by the PKI file:

    \class PingProcess
    
    \brief PingProcess handles and manipulates ping processes.
    
    \example network().getDevice("PC0").getProcess("IcmpProcess").getPingProcess(1)
    
Author:
Auto-generated
  • Method Details

    • start

      void start()
      Information provided by the PKI file:
      
          \brief Starts the ping process.
          
              
    • cancel

      void cancel()
      Information provided by the PKI file:
      
          \brief Cancels the ping process.
          
              
    • getId

      Short getId()
      Information provided by the PKI file:
      
          \brief Returns the ping process ID.
          
          \return short, the ping process ID.
          
              
      Returns:
      Short Returns a Short
    • getDestinationIP

      IPAddress getDestinationIP()
      Information provided by the PKI file:
      
          \brief Returns the destination IP address.
          
          \return ip, the destination IP address.
          
              
      Returns:
      IPAddress Returns a IPAddress
    • getSourceIP

      IPAddress getSourceIP()
      Information provided by the PKI file:
      
          \brief Returns the source IP address.
          
          \return ip, the source IP address.
          
              
      Returns:
      IPAddress Returns a IPAddress
    • getLastIP

      IPAddress getLastIP()
      Information provided by the PKI file:
      
          \brief Returns the last IP address in the ping process.
          
          \return ip, the last IP address in the ping process.
          
              
      Returns:
      IPAddress Returns a IPAddress
    • isBroadcast

      boolean isBroadcast()
      Information provided by the PKI file:
      
          \brief Returns true if the ping process is broadcasted, otherwise false.
          
          \return bool, true if the ping process is broadcasted, otherwise false.
          
              
      Returns:
      boolean Returns a boolean
    • getTotalCount

      int getTotalCount()
      Information provided by the PKI file:
      
          \brief Returns the total number of pings.
          
          \return int, the total number of pings.
          
              
      Returns:
      int Returns a int
    • getSentCount

      int getSentCount()
      Information provided by the PKI file:
      
          \brief Returns the number of echo requests sent.
          
          \return int, the number of echo requests sent.
          
              
      Returns:
      int Returns a int
    • getReceivedCount

      int getReceivedCount()
      Information provided by the PKI file:
      
          \brief Returns the number of echo replies received.
          
          \return int, the number of echo replies received.
          
              
      Returns:
      int Returns a int
    • getTimeout

      int getTimeout()
      Information provided by the PKI file:
      
          \brief Returns the timeout value.
          
          \return int, the timeout value.
          
              
      Returns:
      int Returns a int
    • getMinDelay

      int getMinDelay()
      Information provided by the PKI file:
      
          \brief Returns the minimum delay value.
          
          \return int, the minimum delay value.
          
              
      Returns:
      int Returns a int
    • getMaxDelay

      int getMaxDelay()
      Information provided by the PKI file:
      
          \brief Returns the maximum delay value.
          
          \return int, the maximum delay value.
          
              
      Returns:
      int Returns a int
    • getLastDelay

      int getLastDelay()
      Information provided by the PKI file:
      
          \brief Returns the last delay value.
          
          \return int, the last delay value.
          
              
      Returns:
      int Returns a int
    • getTotalDelay

      int getTotalDelay()
      Information provided by the PKI file:
      
          \brief Returns the total delay value.
          
          \return int, the total delay value.
          
              
      Returns:
      int Returns a int
    • getLastTtl

      int getLastTtl()
      Information provided by the PKI file:
      
          \brief Returns the last TTL value.
          
          \return int, the last TTL value.
          
              
      Returns:
      int Returns a int